Skip to main content

DescribeHaVips

Description

queries highly available virtual IP instances in the specified region.

Request Method

POST

Request Path

/apsara/route/Vpc/DescribeHaVips

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
Filter.N.KeyBODYstringNoHaVipId.havip-bp149uyvut73dpldu****filter conditions, up to 5 filter conditions can be provided. n the value range is 1~5. /span>/p> p data-tag = "p" class = "p"> each filter key can provide multiple values, and the relationship between multiple values is "or", that is, as long as it meets one of the values, it is regarded as the filter condition that meets the parameters. /p> p data-tag = "p" class = "p"> the logical relationship between each filter key is "and", that is, the filter conditions that meet all parameters will be queried. The supported filtering conditions are as follows: VpcId: proprietary network ID. VSwitchId: switch ID. Status:HaVip instance status. HaVipId:HaVip instance ID. HaVipAddress: The IP address of the HaVip instance.
PageSizeBODYintegerNo10The number of rows per page during paging query, the maximum value is 50, the default value is 10.
PageNumberBODYintegerNo1page number of the list, the default value is 1.
regionIdBODYstringYesNo sample value for this parameter.region id
RegionIdBODYstringYescn-qingdao-env17-d01the region ID of the HaVip instance. you can obtain the region by calling DescribeRegions interface ID.
Filter.N.Value.NBODYrepeatlistNo1the value corresponding to the specified filter condition. N The value range is 1~5.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example

Successful Response example

{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}